home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1996 September / JCSM Shareware Collection (JCS Distribution) (September 1996).ISO / prgtools / euphor13.zip / ED.DOC < prev    next >
Text File  |  1995-05-15  |  8KB  |  184 lines
  1.            +-----------------------+
  2.            |  The Euphoria Editor  |
  3.            +-----------------------+
  4.  
  5.  usage: ed filename
  6.     ed
  7.  
  8.  Summary
  9.  -------
  10.  After any error, just type "ed", and you'll be placed in the editor, at the 
  11.  line and column where the error was detected. The error message will be at 
  12.  the top of your screen.
  13.  
  14.  .e, .ex and .pro files are displayed in color. Other text files are in mono. 
  15.  You'll know that you have misspelled something when the color does not change
  16.  as you expect. Keywords are blue. Names of routines that are built in to 
  17.  ex.exe appear in magenta. Strings are brown, comments are red, most other 
  18.  text is black. Balanced brackets (on the same line) have the same color.
  19.  You can change these colors as well as several other parameters of ed. See 
  20.  "user-modifiable parameters" near the top of ed.ex.
  21.  
  22.  The arrow keys move the cursor left, right, up or down. Most other characters
  23.  are immediately inserted into the file. Non-standard keys on the keyboard are
  24.  ignored.
  25.  
  26.  In Windows, you can "associate" various types of files with ed.bat. You will 
  27.  then be put into ed when you double-click on these types of files - e.g. 
  28.  .e, .pro, .doc etc. Main Euphoria files ending in .ex might better be
  29.  associated with "ex.exe".
  30.  
  31.  Ed is a multi-file/multi-window editor. Esc c will split your screen so 
  32.  you can view and edit up to 10 files simultaneously, with cutting and
  33.  pasting between them. You can also use multiple edit windows to view and edit 
  34.  different parts of a single file. 
  35.  
  36.  Special Keys
  37.  ------------
  38.  <delete>         Delete the current character above the cursor.
  39.  
  40.  <back-space>     Move the cursor to the left and delete a character.
  41.  
  42.  <control-delete> 
  43.       or        Delete the current line. (<control-delete> is not
  44.  <control-d>      available on all systems.)
  45.  
  46.  <insert>         Re-insert the preceding series of deletes or
  47.           control-deletes before the current character or
  48.           current line.
  49.  
  50.  <home>           Move to line 1.
  51.  
  52.  <end>            Move to the last line in the file.
  53.  
  54.  <page up>        Move up one screen
  55.  
  56.  <page down>      Move down one screen
  57.  
  58.  F1 ... F10      Select a new current window. The windows are numbered
  59.            from top to bottom, with the top window on the screen
  60.            being F1.
  61.  
  62.  Escape Commands
  63.  ---------------
  64.  Press and release the <Esc> key, then press one of the following keys:
  65.  
  66.  h     Get help text on the editor, or on Euphoria. This operation
  67.       may not work if you are very low on extended memory. 
  68.  
  69.  c     "Clone" the current window, i.e. make a new edit window that is 
  70.       initially viewing the same file at the same position as the
  71.       current window. The sizes of all windows are adjusted to make room
  72.       for the new window. You might want to use Esc l to get more lines
  73.       on the screen. Each window that you create can be scrolled
  74.       independently and each has its own menu bar. The changes that you
  75.       make to a file will initially appear only in the current window.
  76.       When you press an F-key to select a new window, any changes will
  77.       appear there as well. You can use Esc n to read a new file into 
  78.       any window.
  79.  
  80.  q       Quit (delete) the current window and leave the editor if there are 
  81.       no more windows. You'll be warned if this is the last window used for
  82.       editing a modified file. Any remaining windows are given more space.
  83.  
  84.  s       Save the file being edited in the current window, then quit the 
  85.       current window as q above.
  86.  
  87.  w     Save the file but do not quit the window.
  88.  
  89.  e       Save the file, and then execute it with ex. When the program finishes
  90.      execution you'll hear a beep. Hit Enter to return to the editor. 
  91.      This operation may not work if you are very low on extended memory.
  92.      
  93.  d     Run a DOS command. After the beep, hit Enter to return to the editor.
  94.      You can use this command to edit another file and then return. 
  95.  
  96.  n     Start editing a new file in the current window. Deleted lines/chars 
  97.       and search strings are available for use in the new file.
  98.  
  99.  f       Find the next occurrence of a string in the current window. When
  100.       you type in a new string there is an option to "match case" or
  101.       not. Press n if you'll accept a match regardless of upper/lower 
  102.       case. Keep hitting Enter to find subsequent occurrences. Any other 
  103.       key stops the search. To search from the beginning, press the Home 
  104.       key before Esc f.
  105.      
  106.  r     Globally replace one string by another. Operates like f command.
  107.      Keep hitting Enter to continue replacing.
  108.      
  109.  l     Change the number of lines displayed on the screen. Only certain
  110.      values are allowed, depending on your video card. Many cards will
  111.      allow 25, 28, 43 and 50 lines. 
  112.  
  113.  ddd     Move to line number ddd. e.g. Esc 1023 Enter would move to 
  114.       line 1023 in the file.
  115.  
  116.  CR      Esc <Enter> will tell you the name of the current file, as well as
  117.        the line and character position you are on, and whether the file 
  118.        has been modified since the last save.
  119.  
  120.  Cutting and Pasting
  121.  -------------------
  122.  When you <control-delete> a series of consecutive lines, or <delete> a 
  123.  series of consecutive characters, you create a "kill-buffer" containing 
  124.  what you just deleted. This kill-buffer can be re-inserted by moving the
  125.  cursor and then pressing insert. 
  126.  
  127.  A new kill-buffer is started, and the old buffer is lost, each time you 
  128.  move away and start deleting somewhere else. For example, cut a series of 
  129.  lines with <control-delete>. Then move the cursor to where you want to paste
  130.  the lines and press <insert>. If you want to copy the lines, without 
  131.  destroying the original text, first <control-delete> them, then immediately
  132.  press <insert> to re-insert them. Then move somewhere else and press 
  133.  <insert> to insert them again, as many times as you like. You can also 
  134.  <delete> a series of individual *characters*, move the cursor, and then paste
  135.  the deleted characters somewhere else. Immediately press <insert> after 
  136.  deleting if you want to copy without removing the original characters.
  137.  
  138.  Once you have a kill-buffer, you can type Esc n to read in a new file, or you
  139.  can press an F-key to select a new edit window. You can then insert your kill
  140.  buffer.
  141.  
  142.  Use of Tabs
  143.  -----------
  144.  The standard tab width on MS-DOS is 8 spaces. The editor assumes tab=8 for 
  145.  most files. However, it is more convenient when editing a program for a 
  146.  tab to equal the amount of space that you like to indent. Therefore you will
  147.  find that tabs are set to 4 when you edit Euphoria files (or .c, or .h 
  148.  or .bas files). The editor converts from tab=8 to tab=4 when reading your 
  149.  program file, and converts back to tab=8 when you save the file. Thus your
  150.  file remains compatible with the tab=8 world, e.g. MS-DOS PRINT, EDIT, etc.
  151.  If you would like to choose a different number of spaces to indent, change
  152.  the line at the top of ed.ex that says "constant PROG_INDENT = 4".
  153.  
  154.  Lines longer than 80 characters
  155.  -------------------------------
  156.  Lines longer than 80 are marked with an inverse video character in the
  157.  80th column. Ed will not display past column 80. By deleting the carriage 
  158.  return at the end of a line, you can combine it with the next line to create
  159.  a line longer than 80. You can also break a long line by inserting a 
  160.  carriage return.
  161.  
  162.  Maximum File Size
  163.  -----------------
  164.  Like any Euphoria program, ed can use extended memory. It will edit files 
  165.  that are much larger than what MS-DOS EDIT or Windows Notepad can handle,
  166.  especially if it is run under Windows, or with a DOS swap file.
  167.  
  168.  Non-text Files
  169.  --------------
  170.  ed is designed for editing pure text files, although you can use it to
  171.  view other files. As ed reads in a file, it replaces non-printable 
  172.  characters (less than ASCII 32) with ASCII 254 - small square. If you 
  173.  try to save a non-text file you will be warned about this. (MS-DOS EDIT
  174.  will quietly corrupt a non-text file - do not save!)
  175.  
  176.  Source Code
  177.  -----------
  178.  The complete source code to this editor is in bin\ed.ex and bin\syncolor.e. 
  179.  You are welcome to make improvements. There is a section at the top of
  180.  ed.ex containing "user-modifiable" configuration parameters that you
  181.  may want to adjust. The colors may require adjusting for some operating 
  182.  environments.
  183.  
  184.